/*
 * Copyright (c) 2019 - Manifold Systems LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package manifold.api.fs;

import java.util.function.Supplier;
import manifold.internal.javac.HostKind;

/**
 * A fragment of a file that is to be treated separate from the enclosing file.  Facilitates inlining structured
 * content in a Java source file as opposed to using a separate resource file.
 */
public interface IFileFragment extends IFile
{
  IFile getEnclosingFile();
  String getScope();
  int getOffset();
  void setOffset( Supplier<Integer> offset );
  int getLength();
  HostKind getHostKind();

  /** The file element hosting the fragment e.g., a comment or string literal */
  Object getContainer();
  void setContainer( Object container );

  default IFile getPhysicalFile()
  {
    return getEnclosingFile().getPhysicalFile();
  }
}
